<html>
<head>
<title>HTML_Progress::setString</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="10%" align="left" valign="bottom"><a href=
"../HTML_Progress/tutorial_progress.getstring.pkg.html">Prev</a></td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href=
"../HTML_Progress/tutorial_progress.getdm.pkg.html">Next</a></td>
</tr>
</table>
<div><a name=""></a><div class="ref-title-box"><div class="ref-title"><span class="function">HTML_Progress::setString</span></div>
  <div class="ref-purpose">sets the current value of the progress meter string</div></div>

 <span><a name="synopsis"></a><h2 class="title">Synopsis</h2><div class="ref-synopsis"><p><p class="func-synopsis">require_once 'HTML/Progress.php';</p>
    void <span class="function">HTML_Progress::setString</span>(
     string <i>$str</i>)</p></div></span>

 <span><a name="description"></a><h2 class="title">Description</h2><p>This method is used to print a custom string.
   The default value is null, that means the progress meter displays the value returned by 
   <a href="../HTML_Progress/HTML_Progress.html#methodgetPercentComplete">HTML_Progress::getPercentComplete()</a> method formatted as a percent such as 33%.</p>
  <p>The custom progress meter string is painted only if the <a href="../HTML_Progress/HTML_Progress.html#methodisStringPainted">HTML_Progress::isStringPainted()</a> 
   method returns TRUE.</p></span>

 <span><a name="parameter"></a><h2 class="title">Parameter</h2><p><ul class="parameter"><dl><dt>string
      <i>$str</i><dd>
     <li><p>the progress meter custom string.</p></li></dl></ul></p></span>

 <span><a name="note"></a><h2 class="title">Note</h2>( HTML_Progress &gt;= 1.0 )<br />
  <p><table class="note"><tr><td class="note_img"><img src="../media/important.png"></td><td class="note_text">This function can not be called statically.</td></tr></table></p>
  <p><table class="note"><tr><td class="note_img"><img src="../media/tip.png"></td><td class="note_text">If you have provided a custom progress string and want to revert to the built-in-behavior,
    set the string back to NULL.</td></tr></table></p></span>

 <span><a name="see"></a><h2 class="title">See</h2><p><a href="../HTML_Progress/tutorial_progress.getstring.pkg.html">HTML_Progress::getString</a>,
   <a href="../HTML_Progress/tutorial_progress.isstringpainted.pkg.html">HTML_Progress::isStringPainted</a>,
   <a href="../HTML_Progress/tutorial_progress.setstringpainted.pkg.html">HTML_Progress::setStringPainted</a></p></span>

 <span><a name="example"></a><h2 class="title">Example</h2><p>Example below (that requires HTML_Progress &gt;= 1.2.0RC3) will produced a progress bar 
    with a custom string. It's a dynamic example, the progress bar will run.<br />
   <p><table class="note"><tr><td><img src="../media/example.png"></td><td><img src = "../media/screenshots/string.png"/></td></tr></table></p>
   <p><div class="listing"><pre><ol><li><span class="src-php">&lt;?php </span></li>
<li><span class="src-inc">require_once </span><span class="src-str">'HTML/Progress.php'</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li><span class="src-var">$bar </span>= <span class="src-key">new </span><span class="src-id"><a href="../HTML_Progress/HTML_Progress.html">HTML_Progress</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setAnimSpeed</span><span class="src-sym">(</span><span class="src-num">100</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setIncrement</span><span class="src-sym">(</span><span class="src-num">5</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setStringPainted</span><span class="src-sym">(</span><span class="src-id">true</span><span class="src-sym">)</span><span class="src-sym">;     </span><span class="src-comm">// get space for the string</span></li>
<li><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setString</span><span class="src-sym">(</span><span class="src-str">''</span><span class="src-sym">)</span><span class="src-sym">;              </span><span class="src-comm">// but don't paint it</span></li>
<li>&nbsp;</li>
<li><span class="src-var">$ui </span>=<span class="src-sym">&amp; </span><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">getUI</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-var">$ui</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">setStringAttributes</a><span class="src-sym">(</span><span class="src-str">'width=350 align=left'</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-php">?&gt;</span></li>
<li>&lt;html&gt;</li>
<li>&lt;head&gt;</li>
<li>&lt;title&gt;setString example&lt;/title&gt;</li>
<li>&lt;style type=&quot;text/css&quot;&gt;</li>
<li>&lt;!--</li>
<li><span class="src-php">&lt;?php </span>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">getStyle</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?&gt;</span></li>
<li>// --&gt;</li>
<li>&lt;/style&gt;</li>
<li>&lt;script type=&quot;text/javascript&quot;&gt;</li>
<li>&lt;!--</li>
<li><span class="src-php">&lt;?php </span>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><a href="../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">getScript</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-php">?&gt;</span></li>
<li>//--&gt;</li>
<li>&lt;/script&gt;</li>
<li>&lt;/head&gt;</li>
<li>&lt;body&gt;</li>
<li>&nbsp;</li>
<li><span class="src-php">&lt;?php </span></li>
<li>echo <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">toHtml</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span></li>
<li>&nbsp;</li>
<li><span class="src-var">$pkg </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-str">'PEAR'</span><span class="src-sym">, </span><span class="src-str">'Archive_Tar'</span><span class="src-sym">, </span><span class="src-str">'Config'</span><span class="src-sym">, </span></li>
<li>    <span class="src-str">'HTML_QuickForm'</span><span class="src-sym">, </span><span class="src-str">'HTML_CSS'</span><span class="src-sym">, </span><span class="src-str">'HTML_Page'</span><span class="src-sym">, </span><span class="src-str">'HTML_Template_Sigma'</span><span class="src-sym">, </span></li>
<li>    <span class="src-str">'Log'</span><span class="src-sym">, </span><span class="src-str">'MDB'</span><span class="src-sym">, </span><span class="src-str">'PHPUnit'</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li>do <span class="src-sym">{</span></li>
<li>    <span class="src-var">$val </span>= <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">getValue</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>    <span class="src-var">$i </span>= <a href="http://www.php.net/floor">floor</a><span class="src-sym">(</span><span class="src-var">$val </span>/ <span class="src-num">10</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>    <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$val </span>== <span class="src-num">100</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li>        <span class="src-var">$msg </span>= <span class="src-str">''</span><span class="src-sym">;</span></li>
<li>    <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
<li>        <span class="src-var">$msg  </span>= <span class="src-str">&quot;</span>&amp;<span class="src-id">nbsp</span>; <span class="src-id">installing package</span> (<span class="src-var">$val</span> %) ... : <span class="src-str">&quot;</span><span class="src-sym">;</span></li>
<li>        <span class="src-var">$msg </span>.= <span class="src-var">$pkg</span><span class="src-sym">[</span><span class="src-var">$i</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
<li>    <span class="src-sym">}</span></li>
<li>    <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">setString</span><span class="src-sym">(</span><span class="src-var">$msg</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>&nbsp;</li>
<li>    <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">display</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li>    <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">getPercentComplete</span><span class="src-sym">(</span><span class="src-sym">) </span>== <span class="src-num">1</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
<li>        <span class="src-key">break</span><span class="src-sym">;   </span><span class="src-comm">// the progress bar has reached 100%</span></li>
<li>    <span class="src-sym">}</span></li>
<li>    <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><a href="http://www.php.net/sleep">sleep</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;  </span><span class="src-comm">// for purpose of demo only</span></li>
<li>    <span class="src-var">$bar</span><span class="src-sym">-&gt;</span><span class="src-id">incValue</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-sym">} </span><span class="src-key">while</span><span class="src-sym">(</span><span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
<li><span class="src-php">?&gt;</span></li>
<li>&nbsp;</li>
<li>&lt;/body&gt;</li>
<li>&lt;/html&gt;</li>
</ol></pre></div></p></p></span></div>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_progress.getstring.pkg.html">Prev</a></td>
<td width="34%" align="center" valign="top"><a href=
"../HTML_Progress/tutorial_part3-reference.pkg.html">Up</a></td>
<td width="33%" align="right" valign="top"><a href=
"../HTML_Progress/tutorial_progress.getdm.pkg.html">Next</a></td>
</tr>

<tr>
<td width="33%" align="left" valign="top"><span class="function">HTML_Progress::getString</span></td>
<td width="34%" align="center" valign="top">Reference Guide</td>
<td width="33%" align="right" valign="top"><span class="function">HTML_Progress::getDM</span></td>
</tr>
</table>
        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:06 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>